/**
 * @(#)SocialManager 06/03/2015
 *
 * Copyright (c) 2005-2015 PsiqueWare S.A. de C.V. All Rights Reserved.
 * This software is the proprietary information PsiqueWare S.A. de C.V.
 * Use is subject to license terms.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * <br/>Usuario : AngelElectrico
 * <br/>Creaci&oacute;n:06/03/2015 - 03:16 PM PM
 * <br/>
 * <br/>
 * <br/><t5>Cambios :</t5>
 * <br/><b>Fecha | Autor  |  Cambios</b>
 * <ul>
 * <li>06/03/2015 | <a href = "mailto:AngelElectrico@PsiqueWare.com">&Aacute;ngel El&eacute;ctrico</a> | Creaci&oacute;n del Objeto.</li>
 *
 * </ul>
 */
package com.psiqueware.alheli.id;

import com.psiqueware.alheli.dao.EnlaceTransaccional;
import com.psiqueware.alheli.manager.BaseManagerInterface;
import com.psiqueware.alheli.manager.ManagerException;

/**
 * Administrador de las identificaciones sociales.
 * <br/>Paquete Original: com.psiqueware.alheli.id
 * <br/>Nombre  Original: SocialManager
 * <br/>Oprima para ver : <a href="SocialManager.java.html"><i>C&oacute;digo Fuente</i> </a>
 *
 * @author <a href="mailto:AngelElectrico@PsiqueWare.com">&Aacute;ngel El&eacute;ctrico</a>
 * @version Revision: 1.1 06/03/2015 03:16 PM
 */
public interface SocialManager extends BaseManagerInterface
{
    /**
     * Devuelve un {@link com.psiqueware.alheli.id.PerfilSocial} a partir de su identificador &uacute;nico.
     *
     * @param id                  Identificador &uacute;nico del {@link com.psiqueware.alheli.id.PerfilSocial}.
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return {@link com.psiqueware.alheli.id.PerfilSocial} en caso de encontrarse; <code>null</code> en caso contrario.
     *
     * @throws com.psiqueware.alheli.manager.ManagerException En caso de un error.
     */
    PerfilSocial buscaPerfilSocialPorId(Long id, EnlaceTransaccional enlaceTransaccional) throws ManagerException;

    /**
     * Agrega un nuevo {@link com.psiqueware.alheli.id.PerfilSocial} al {@link com.psiqueware.alheli.id.Usuario}.
     *
     * @param usuario                {@link com.psiqueware.alheli.id.Usuario} al cual pertenece este {@link com.psiqueware.alheli.id.PerfilSocial}. <br/> En Spring Social userId: {@link com.psiqueware.alheli.id.Usuario#getIdentificacion()} usando <code>idUsuario</code> para llegar.
     * @param identificacionSocial   Nombre de usuario en la aplicaci&oacute;n remota. <br/> En Spring Social providerUserId: <code>identificacionSocial</code>.
     * @param prioridad              Prioridad que indica que si el usuario tiene m&uacute;ltiples conexiones cu&aacute;l se usar&aacute; primero. <br/> En Spring Social rank: <code>prioridad</code>.
     * @param direccionPerfil        Cadena con la {@link java.net.URI} que apunta al perfil social. <br/> En Spring Social profileUrl: direccionPerfil.
     * @param direccionImagen        imageUrl: direccionImagen.
     * @param identificacionRemota   accessToken: identificacionRemota.
     * @param autentificacionRemota  secret: autentificacionRemota.
     * @param identificacionRefresco refreshToken: identificacionRefresco.
     * @param expiracion             expireTime: expiracion.
     * @param enlaceTransaccional    Enlace para hacer at&oacute;micas las trasacciones.
     *
     * @return El nuevo {@link com.psiqueware.alheli.id.PerfilSocial}.
     *
     * @throws com.psiqueware.alheli.manager.ManagerException En caso de un error.
     */
    PerfilSocial nuevoPerfilSocial(Usuario usuario, String identificacionSocial, int prioridad, String direccionPerfil, String direccionImagen, String identificacionRemota, char[] autentificacionRemota, String identificacionRefresco, long expiracion, EnlaceTransaccional enlaceTransaccional) throws ManagerException;

    /**
     * Actualiza los datos del {@link com.psiqueware.alheli.id.PerfilSocial}.
     *
     * @param perfilSocial           A actualizar.
     * @param identificacionSocial   Nombre de usuario en la aplicaci&oacute;n remota. <br/> En Spring Social providerUserId: <code>identificacionSocial</code>.
     * @param prioridad              Prioridad que indica que si el usuario tiene m&uacute;ltiples conexiones cu&aacute;l se usar&aacute; primero. <br/> En Spring Social rank: <code>prioridad</code>.
     * @param direccionPerfil        Cadena con la {@link java.net.URI} que apunta al perfil social. <br/> En Spring Social profileUrl: direccionPerfil.
     * @param direccionImagen        imageUrl: direccionImagen.
     * @param identificacionRemota   accessToken: identificacionRemota.
     * @param autentificacionRemota  secret: autentificacionRemota.
     * @param identificacionRefresco refreshToken: identificacionRefresco.
     * @param expiracion             expireTime: expiracion.
     * @param enlaceTransaccional    Enlace para hacer at&oacute;micas las trasacciones.
     *
     * @throws com.psiqueware.alheli.manager.ManagerException En caso de un error.
     */
    void actualizaPerfilSocial(PerfilSocial perfilSocial, String identificacionSocial, int prioridad, String direccionPerfil, String direccionImagen, String identificacionRemota, char[] autentificacionRemota, String identificacionRefresco, long expiracion, EnlaceTransaccional enlaceTransaccional) throws ManagerException;

    /**
     * Carga el conjunto de {@link com.psiqueware.alheli.id.PerfilSocial} asociados con el {@link com.psiqueware.alheli.id.Usuario}.
     *
     * @param usuario             Cuyos {@link com.psiqueware.alheli.id.PerfilSocial} es necesario cargar.
     * @param enlaceTransaccional Enlace para hacer at&oacute;micas las trasacciones.
     *
     * @return <code>true</code> si existen {@link com.psiqueware.alheli.id.PerfilSocial} asociados al {@link com.psiqueware.alheli.id.Usuario}; <code>false</code> en caso contrario.
     *
     * @throws com.psiqueware.alheli.manager.ManagerException En caso de un error.
     */
    boolean cargaPerfilesSociales(Usuario usuario, EnlaceTransaccional enlaceTransaccional) throws ManagerException;

    /**
     * Elimina un {@link PerfilSocial}.
     *
     * @param perfilSocial        A eliminar.
     * @param enlaceTransaccional Enlace para hacer at&oacute;micas las trasacciones.
     *
     * @throws ManagerException En caso de un error.
     */
    void eliminarPerfilSocial(final PerfilSocial perfilSocial, final EnlaceTransaccional enlaceTransaccional) throws ManagerException;
}
